Float

class Float : Number, Comparable<Float>

Represents a single-precision 32-bit IEEE 754 floating point number. On the JVM, non-nullable values of this type are represented as values of the primitive type float.

Types

Companion

object Companion

Functions

compareTo

operator fun compareTo(other: Byte): Int

operator fun compareTo(other: Double): Int

open operator override fun compareTo(other: Float): Int

operator fun compareTo(other: Int): Int

operator fun compareTo(other: Long): Int

operator fun compareTo(other: Short): Int

Compares this value with the specified value for order. Returns zero if this value is equal to the specified other value, a negative number if it's less than other, or a positive number if it's greater than other.

dec

operator fun dec(): Float

Decrements this value.

div

operator fun div(other: Byte): Float

operator fun div(other: Double): Double

operator fun div(other: Float): Float

operator fun div(other: Int): Float

operator fun div(other: Long): Float

operator fun div(other: Short): Float

Divides this value by the other value.

inc

operator fun inc(): Float

Increments this value.

minus

operator fun minus(other: Byte): Float

operator fun minus(other: Double): Double

operator fun minus(other: Float): Float

operator fun minus(other: Int): Float

operator fun minus(other: Long): Float

operator fun minus(other: Short): Float

Subtracts the other value from this value.

plus

operator fun plus(other: Byte): Float

operator fun plus(other: Double): Double

operator fun plus(other: Float): Float

operator fun plus(other: Int): Float

operator fun plus(other: Long): Float

operator fun plus(other: Short): Float

Adds the other value to this value.

rem

operator fun rem(other: Byte): Float

operator fun rem(other: Double): Double

operator fun rem(other: Float): Float

operator fun rem(other: Int): Float

operator fun rem(other: Long): Float

operator fun rem(other: Short): Float

Calculates the remainder of truncating division of this value by the other value.

Since Kotlin

1.1

times

operator fun times(other: Byte): Float

operator fun times(other: Double): Double

operator fun times(other: Float): Float

operator fun times(other: Int): Float

operator fun times(other: Long): Float

operator fun times(other: Short): Float

Multiplies this value by the other value.

toByte

@DeprecatedSinceKotlin(warningSince = "1.3", errorSince = "1.5")

~~open~~ ~~override~~ ~~fun~~ ~~toByte~~(): Byte

Converts this Float value to Byte.

toChar

@DeprecatedSinceKotlin(warningSince = "1.5")

~~open~~ ~~override~~ ~~fun~~ ~~toChar~~(): Char

Converts this Float value to Char.

toDouble

open override fun toDouble(): Double

Converts this Float value to Double.

toFloat

open override fun toFloat(): Float

Returns this value.

toInt

open override fun toInt(): Int

Converts this Float value to Int.

toLong

open override fun toLong(): Long

Converts this Float value to Long.

toShort

@DeprecatedSinceKotlin(warningSince = "1.3", errorSince = "1.5")

~~open~~ ~~override~~ ~~fun~~ ~~toShort~~(): Short

Converts this Float value to Short.

unaryMinus

operator fun unaryMinus(): Float

Returns the negative of this value.

unaryPlus

operator fun unaryPlus(): Float

Returns this value.

Extensions

absoluteValue

expect val Float.absoluteValue: Float

Returns the absolute value of this value.

actual val Float.absoluteValue: Float

Returns the absolute value of this value.

actual val Float.absoluteValue: Float

Returns the absolute value of this value.

actual val Float.absoluteValue: Float

Returns the absolute value of this value.

coerceAtLeast

fun Float.coerceAtLeast(minimumValue: Float): Float

Ensures that this value is not less than the specified minimumValue.

coerceAtMost

fun Float.coerceAtMost(maximumValue: Float): Float

Ensures that this value is not greater than the specified maximumValue.

coerceIn

fun Float.coerceIn(minimumValue: Float, maximumValue: Float): Float

Ensures that this value lies in the specified range minimumValue..maximumValue.

IEEErem

inline fun Float.IEEErem(divisor: Float): Float

Computes the remainder of division of this value by the divisor value according to the IEEE 754 standard.

external fun Float.IEEErem(divisor: Float): Float

Computes the remainder of division of this value by the divisor value according to the IEEE 754 standard.

isFinite

expect fun Float.isFinite(): Boolean

actual inline fun Float.isFinite(): Boolean

Returns true if the argument is a finite floating-point value; returns false otherwise (for NaN and infinity arguments).

actual fun Float.isFinite(): Boolean

Returns true if the argument is a finite floating-point value; returns false otherwise (for NaN and infinity arguments).

actual external fun Float.isFinite(): Boolean

Returns true if the argument is a finite floating-point value; returns false otherwise (for NaN and infinity arguments).

isInfinite

expect fun Float.isInfinite(): Boolean

actual inline fun Float.isInfinite(): Boolean

Returns true if this value is infinitely large in magnitude.

actual fun Float.isInfinite(): Boolean

Returns true if this value is infinitely large in magnitude.

actual external fun Float.isInfinite(): Boolean

Returns true if this value is infinitely large in magnitude.

isNaN

expect fun Float.isNaN(): Boolean

actual inline fun Float.isNaN(): Boolean

Returns true if the specified number is a Not-a-Number (NaN) value, false otherwise.

actual fun Float.isNaN(): Boolean

Returns true if the specified number is a Not-a-Number (NaN) value, false otherwise.

actual external fun Float.isNaN(): Boolean

Returns true if the specified number is a Not-a-Number (NaN) value, false otherwise.

mod

inline fun Float.mod(other: Float): Float

inline fun Float.mod(other: Double): Double

Calculates the remainder of flooring division of this value by the other value.

nextDown

inline fun Float.nextDown(): Float

Returns the Float value nearest to this value in direction of negative infinity.

external fun Float.nextDown(): Float

Returns the Float value nearest to this value in direction of negative infinity.

nextTowards

inline fun Float.nextTowards(to: Float): Float

Returns the Float value nearest to this value in direction from this value towards the value to.

external fun Float.nextTowards(to: Float): Float

Returns the Float value nearest to this value in direction from this value towards the value to.

nextUp

inline fun Float.nextUp(): Float

Returns the Float value nearest to this value in direction of positive infinity.

external fun Float.nextUp(): Float

Returns the Float value nearest to this value in direction of positive infinity.

pow

expect fun Float.pow(x: Float): Float

Raises this value to the power x.

expect fun Float.pow(n: Int): Float

Raises this value to the integer power n.

actual inline fun Float.pow(x: Float): Float

Raises this value to the power x.

actual inline fun Float.pow(n: Int): Float

Raises this value to the integer power n.

actual inline fun Float.pow(x: Float): Float

Raises this value to the power x.

actual inline fun Float.pow(n: Int): Float

Raises this value to the integer power n.

actual external fun Float.pow(x: Float): Float

Raises this value to the power x.

actual fun Float.pow(n: Int): Float

Raises this value to the integer power n.

rangeTo

operator fun Float.rangeTo(that: Float): ClosedFloatingPointRange<Float>

Creates a range from this Float value to the specified that value.

roundToInt

expect fun Float.roundToInt(): Int

Rounds this Float value to the nearest integer and converts the result to Int. Ties are rounded towards positive infinity.

actual fun Float.roundToInt(): Int

Rounds this Float value to the nearest integer and converts the result to Int. Ties are rounded towards positive infinity.

actual inline fun Float.roundToInt(): Int

Rounds this Float value to the nearest integer and converts the result to Int. Ties are rounded towards positive infinity.

actual fun Float.roundToInt(): Int

Rounds this Float value to the nearest integer and converts the result to Int. Ties are rounded towards positive infinity.

roundToLong

expect fun Float.roundToLong(): Long

Rounds this Float value to the nearest integer and converts the result to Long. Ties are rounded towards positive infinity.

actual fun Float.roundToLong(): Long

Rounds this Float value to the nearest integer and converts the result to Long. Ties are rounded towards positive infinity.

actual inline fun Float.roundToLong(): Long

Rounds this Float value to the nearest integer and converts the result to Long. Ties are rounded towards positive infinity.

actual fun Float.roundToLong(): Long

Rounds this Float value to the nearest integer and converts the result to Long. Ties are rounded towards positive infinity.

sign

expect val Float.sign: Float

Returns the sign of this value:

actual val Float.sign: Float

Returns the sign of this value:

actual val Float.sign: Float

Returns the sign of this value:

actual val Float.sign: Float

Returns the sign of this value:

toBigDecimal

inline fun Float.toBigDecimal(): BigDecimal

inline fun Float.toBigDecimal(mathContext: MathContext): BigDecimal

Returns the value of this Float number as a BigDecimal.

toBits

expect fun Float.toBits(): Int

Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout.

actual inline fun Float.toBits(): Int

Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout.

actual fun Float.toBits(): Int

Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout.

actual inline fun Float.toBits(): Int

Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout.

toRawBits

expect fun Float.toRawBits(): Int

Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout, preserving NaN values exact layout.

actual inline fun Float.toRawBits(): Int

Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout, preserving NaN values exact layout.

actual fun Float.toRawBits(): Int

Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout, preserving NaN values exact layout.

actual inline fun Float.toRawBits(): Int

Returns a bit representation of the specified floating-point value as Int according to the IEEE 754 floating-point "single format" bit layout, preserving NaN values exact layout.

toUInt